Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

PMM-7999 Add Quickstart guide #1159

Merged
merged 112 commits into from
Dec 20, 2023
Merged

PMM-7999 Add Quickstart guide #1159

merged 112 commits into from
Dec 20, 2023

Conversation

rasika-chivate
Copy link
Collaborator

Add quickstart guide for PMM

@render
Copy link

render bot commented Oct 6, 2023

@rasika-chivate rasika-chivate marked this pull request as ready for review October 6, 2023 08:26
@percona percona deleted a comment from render bot Oct 6, 2023
@mmnosek
Copy link
Contributor

mmnosek commented Dec 15, 2023

I love the improvements! A few comments after having a quick look:

  1. I would change "Install PMM" headline to "Install PMM Server"
  2. I would change "Once PMM is set up, choose the database that you want it to monitor:" to "Once PMM Server is set up, choose the service that you want it to monitor" (technically, we also monitor ProxySQL and HAProxy which are not DBs
  3. Installing PMM package step in each tech would benefit from having two tabs - with Debian and RHEL commands (apt-get vs yum).
  4. "Install Percona Release Tool" should be linked ti its documentation
  5. "Alternative database connection workflows" tab has "PMM Client installation via User Interface" link. I think it would be better to rename it to "Adding remote instance via User Interface" (because technically it does not install PMM Client anywhere)
  6. Postgres instructions are incomplete. They miss steps required to enable pg_stat_monitor.
  7. Step 2 of POstgres instructions are too long. I don't think all the explanation what pg_stat_monitor is is required.

@rnovikovP
Copy link
Contributor

  1. I would change "Install PMM" headline to "Install PMM Server"
    This was intentional (my ask) to keep users from overloading about Client-server and options.
    As the main action they expect - is "install PMM," not "some pmm components,"
  1. I would change "Once PMM is set up, choose the database that you want it to monitor:" to "Once PMM Server is set up, choose the service that you want it to monitor" (technically, we also monitor ProxySQL and HAProxy which are not DBs

Perhaps we should label it as "Database or Application" instead. Terms like Services and Nodes are internal jargon, and using PMM is the best way to get familiar with them. Our goal is to use language that is easily understandable to users in our initial interactions.

Will all other suggestions - 👍

@rnovikovP rnovikovP self-requested a review December 18, 2023 13:35
@catalinaadam catalinaadam merged commit 8b337fc into main Dec 20, 2023
@catalinaadam catalinaadam deleted the Quick_start_guide branch December 20, 2023 12:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants